<html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Hammerspoon docs: RoundedCorners</title>
    <style type="text/css">
      a { text-decoration: none; }
      a:hover { text-decoration: underline; }
      th { background-color: #DDDDDD; vertical-align: top; padding: 3px; }
      td { width: 100%; background-color: #EEEEEE; vertical-align: top; padding: 3px; }
      table { width: 100% ; border: 1px solid #0; text-align: left; }
      section > table table td { width: 0; }
    </style>
    <link rel="stylesheet" href="docs.css" type="text/css" media="screen" />
  </head>
  <body>
    <header>
      <h1><a href="./index.html">docs</a> &raquo; RoundedCorners</h1>
      <p>Give your screens rounded corners</p>
<p>Download: <a href="https://github.com/Hammerspoon/Spoons/raw/master/Spoons/RoundedCorners.spoon.zip">https://github.com/Hammerspoon/Spoons/raw/master/Spoons/RoundedCorners.spoon.zip</a></p>

      </header>
      <h3>API Overview</h3>
      <ul>
        <li>Variables - Configurable values</li>
          <ul>
            <li><a href="#allScreens">allScreens</a></li>
            <li><a href="#level">level</a></li>
            <li><a href="#radius">radius</a></li>
          </ul>
        <li>Methods - API calls which can only be made on an object returned by a constructor</li>
          <ul>
            <li><a href="#start">start</a></li>
            <li><a href="#stop">stop</a></li>
          </ul>
      </ul>
      <h3>API Documentation</h3>
        <h4 class="documentation-section">Variables</h4>
          <section id="allScreens">
            <a name="//apple_ref/cpp/Variable/allScreens" class="dashAnchor"></a>
            <h5><a href="#allScreens">allScreens</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>RoundedCorners.allScreens</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Controls whether corners are drawn on all screens or just the primary screen. Defaults to true</p>
</td>
              </tr>
              <tr>
                <th>Source</th>
                <td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/RoundedCorners.spoon/init.lua#L19">Source/RoundedCorners.spoon/init.lua line 19</a></td>
              </tr>
            </table>
          </section>
          <section id="level">
            <a name="//apple_ref/cpp/Variable/level" class="dashAnchor"></a>
            <h5><a href="#level">level</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>RoundedCorners.level</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Controls which level of the screens the corners are drawn at. See <code>hs.canvas.windowLevels</code> for more information. Defaults to <code>screenSaver + 1</code></p>
</td>
              </tr>
              <tr>
                <th>Source</th>
                <td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/RoundedCorners.spoon/init.lua#L29">Source/RoundedCorners.spoon/init.lua line 29</a></td>
              </tr>
            </table>
          </section>
          <section id="radius">
            <a name="//apple_ref/cpp/Variable/radius" class="dashAnchor"></a>
            <h5><a href="#radius">radius</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>RoundedCorners.radius</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Controls the radius of the rounded corners, in points. Defaults to 6</p>
</td>
              </tr>
              <tr>
                <th>Source</th>
                <td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/RoundedCorners.spoon/init.lua#L24">Source/RoundedCorners.spoon/init.lua line 24</a></td>
              </tr>
            </table>
          </section>
        <h4 class="documentation-section">Methods</h4>
          <section id="start">
            <a name="//apple_ref/cpp/Method/start" class="dashAnchor"></a>
            <h5><a href="#start">start</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>RoundedCorners:start()</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Starts RoundedCorners</p>
</td>
              </tr>
              <tr>
                  <th>Parameters</th>
                  <td><ul>
<li>None</li>
</ul>
</td>
              </tr>
              <tr>
                  <th>Returns</th>
                  <td><ul>
<li>The RoundedCorners object</li>
</ul>
</td>
              </tr>
              <tr>
                  <th>Notes</th>
                  <td><ul>
<li>This will draw the rounded screen corners and start watching for changes in screen sizes/layouts, reacting accordingly</li>
</ul>
</td>
              </tr>
              <tr>
                <th>Source</th>
                <td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/RoundedCorners.spoon/init.lua#L45">Source/RoundedCorners.spoon/init.lua line 45</a></td>
              </tr>
            </table>
          </section>
          <section id="stop">
            <a name="//apple_ref/cpp/Method/stop" class="dashAnchor"></a>
            <h5><a href="#stop">stop</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>RoundedCorners:stop()</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Stops RoundedCorners</p>
</td>
              </tr>
              <tr>
                  <th>Parameters</th>
                  <td><ul>
<li>None</li>
</ul>
</td>
              </tr>
              <tr>
                  <th>Returns</th>
                  <td><ul>
<li>The RoundedCorners object</li>
</ul>
</td>
              </tr>
              <tr>
                  <th>Notes</th>
                  <td><ul>
<li>This will remove all rounded screen corners and stop watching for changes in screen sizes/layouts</li>
</ul>
</td>
              </tr>
              <tr>
                <th>Source</th>
                <td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/RoundedCorners.spoon/init.lua#L63">Source/RoundedCorners.spoon/init.lua line 63</a></td>
              </tr>
            </table>
          </section>
  </body>
</html>